docs(skill): clarify bsk evaluate exit-code vs --json .ok semantics - #151
Merged
Conversation
The exit code reflects RPC success only, not JS success. Document that programmatic callers must use --json and check the .ok field to detect JS errors. Addresses the discoverability gap raised in issue Tencent#133.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Addresses the discoverability gap raised in #133.
bsk evaluate's exit code reflects RPC success only, not JS success. The structured--jsonoutput already returnsok/value/error, but SKILL.md only said "JS throw → stderr, exit 0", which led agents to misreadexit 0as "JS succeeded".Change
Two small doc clarifications, applied to both
skill/SKILL.mdandcrates/bsk-cli/skill/SKILL.md(kept in sync):Scripting & timing): note that programmatic callers should use--jsonand check.okto detect JS errors.0row): pointevaluatecallers to--json.okto distinguish JS success from RPC success.Documentation only — no behavior change.